feat: wrap exceptions thrown while authenticating #42
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jajeffries
requested review from
leoparente,
ltucker and
mfiedorowicz
as code owners
mfiedorowicz
changed the title
mfiedorowicz
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR improves error handling in the authentication process and enhances test coverage in the client module.
- Replaces an incorrect return statement with raise for proper exception propagation.
- Adds try-except handling in the authenticate method to raise a DiodeConfigError on failure.
- Introduces a new test to validate exception handling during authentication requests.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| netboxlabs/diode/sdk/client.py | Updates exception handling in both ingest and authenticate methods. |
| tests/test_client.py | Adds a new test for request exceptions and includes minor formatting adjustments. |
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes improvements to error handling and test coverage in the
netboxlabs/diode/sdk/client.pyfile and its associated tests. The most important changes include replacing areturnstatement with araisestatement for consistency, adding exception handling during authentication, and introducing a new test to validate error handling for connection exceptions.Error handling improvements:
return RuntimeErrorwithraise RuntimeErrorin theingestmethod to ensure proper exception handling. (netboxlabs/diode/sdk/client.py, netboxlabs/diode/sdk/client.pyL240-R240)try-exceptblock in theauthenticatemethod to handle exceptions during the HTTP request and raise aDiodeConfigErrorwith a meaningful message. (netboxlabs/diode/sdk/client.py, netboxlabs/diode/sdk/client.pyR292-R296)Test coverage enhancements:
test_diode_authentication_request_exception, to verify that an exception during the HTTP request in theauthenticatemethod raises aDiodeConfigErrorwith the correct error message. (tests/test_client.py, tests/test_client.pyR616-R633)tests/test_client.py, tests/test_client.pyR591)